API endpoints

Domestic ovens

The base URL for all paths is https://create-energy-label.service.gov.uk. No authentication is required for any endpoints.

Electric ovens: arrow image

Path

/api/v1/domestic-ovens/electric-ovens/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class of the cavity. Must be one of: A+++ A++ A+ A B C D	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Electric ovens: energy label

You must attach the label to the front or top of the product so that it’s easy to see. It must be at least 85mm x 170mm when printed.

Path

/api/v1/domestic-ovens/electric-ovens/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	The energy efficiency class of the cavity. Must be one of: A+++ A++ A+ A B C D	String
volume	Usable volume of the cavity in litres (L). This may be up to 3 digits long.	Integer
conventionalKwhConsumption	Energy consumption of the conventional heating function per cycle, in kWh/cycle. This may be up to 1 digit long with an optional 2 decimal places.	Number
isFanOven	Is this a fan-forced oven?	Boolean
convectionKwhConsumption	Energy consumption of the fan-forced heating function per cycle, in kWh/cycle. Only required if isFanOven is true. This may be up to 1 digit long with an optional 2 decimal places.	Number

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+++", "volume": 1, "conventionalKwhConsumption": 1.1, "isFanOven": true, "convectionKwhConsumption": 1.1 }

Gas ovens: arrow image

Path

/api/v1/domestic-ovens/gas-ovens/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class of the cavity. Must be one of: A+++ A++ A+ A B C D	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Gas ovens: energy label

You must attach the label to the front or top of the product so that it’s easy to see. It must be at least 85mm x 170mm when printed.

Path

/api/v1/domestic-ovens/gas-ovens/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	The energy efficiency class of the cavity. Must be one of: A+++ A++ A+ A B C D	String
volume	Usable volume of the cavity in litres (L). This may be up to 3 digits long.	Integer
conventionalKwhConsumption	Energy consumption of the conventional heating function per cycle, in kWh/cycle. This may be up to 1 digit long with an optional 2 decimal places.	Number
isFanOven	Is this a fan-forced oven?	Boolean
convectionKwhConsumption	Energy consumption of the fan-forced heating function per cycle, in kWh/cycle. Only required if isFanOven is true. This may be up to 1 digit long with an optional 2 decimal places.	Number
conventionalMjConsumption	Energy consumption of the conventional heating function per cycle, in MJ/cycle. This may be up to 1 digit long with an optional 2 decimal places.	Number
convectionMjConsumption	Energy consumption of the fan-forced heating function per cycle, in MJ/cycle. Only required if isFanOven is true. This may be up to 1 digit long with an optional 2 decimal places.	Number

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+++", "volume": 1, "conventionalKwhConsumption": 1.1, "isFanOven": true, "convectionKwhConsumption": 1.1, "conventionalMjConsumption": 1.1, "convectionMjConsumption": 1.1 }